// Pipeline Component Library Example
// ----------------------------------
// Colin Bowern (colinbowern@hotmail.com)
// January 2007
//
// Copyright (c) 2007 Colin Bowern
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// * The above copyright notice and this permission notice shall be included in
//   all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#region References
using Microsoft.CommerceServer.Catalog;
using Microsoft.CommerceServer.Interop;
using Microsoft.CommerceServer.Interop.Caching;
using Microsoft.CommerceServer.Runtime;
using Microsoft.CommerceServer.Runtime.Configuration;
using System;
using System.Collections.Generic;
using System.Runtime.InteropServices;
using System.Text;
#endregion

namespace RockstarGuys.PipelineComponents
{
    /// <summary>
    /// Encapsulates a context dictionary and pipeline message collection used during execution of an Orders pipeline.
    /// </summary>
    /// <remarks>
    /// For more information see http://msdn2.microsoft.com/en-us/library/microsoft.commerceserver.runtime.orders.pipelineinfo.aspx
    /// </remarks>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1035:ICollectionImplementationsHaveStronglyTypedMembers")]
    public class PipelineContext : Dictionary
    {
        #region Fields
        private CommerceResources commerceResources;
        #endregion

        #region Properties
        /// <remarks />
        [CLSCompliant(false)]
        public ICacheManager CacheManager
        {
            get { return this[PipelineContext.KeyNames.CacheManager] as ICacheManager; }
            set { this[PipelineContext.KeyNames.CacheManager] = value; }
        }

        /// <remarks />
        public CatalogContext CatalogContext
        {
            get { return this[PipelineContext.KeyNames.CatalogContext] as CatalogContext; }
            set { this[PipelineContext.KeyNames.CatalogContext] = value; }
        }

        /// <remarks />
        public string CatalogLanguage
        {
            get { return this[PipelineContext.KeyNames.CatalogLanguage] as string; }
            set { this[PipelineContext.KeyNames.CatalogLanguage] = value; }
        }

        /// <remarks />
        public string TransactionConfigConnectionString
        {
            get { return this[PipelineContext.KeyNames.TransactionConfigConnectionString] as string; }
            set { this[PipelineContext.KeyNames.TransactionConfigConnectionString] = value; }
        }

        /// <remarks />
        [CLSCompliant(false)]
        public IMessageManager MessageManager
        {
            get { return this[PipelineContext.KeyNames.MessageManager] as IMessageManager; }
            set { this[PipelineContext.KeyNames.MessageManager] = value; }
        }

        /// <remarks />
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
        public CommerceResources CommerceResources
        {
            get
            {
                if (commerceResources == null)
                {
                    CommerceResourceCollection commerceResourceCollection = this[PipelineContext.KeyNames.CommerceResources] as CommerceResourceCollection;
                    if (commerceResourceCollection != null)
                    {
                        commerceResources = new CommerceResources(commerceResourceCollection);
                    }
                }
                return commerceResources;
            }
            set { this[PipelineContext.KeyNames.CommerceResources] = (value != null ? value.CommerceResourceCollection : null); }
        }
        #endregion

        #region Constructor
        /// <summary>
        /// Initializes a new instance of the <see cref="T:PipelineContext"/> class.
        /// </summary>
        /// <remarks>
        /// The underlying store can be persisted through referencing the InnerList property.
        /// </remarks>
        public PipelineContext() : base() { }

        /// <summary>
        /// Initializes a new instance of the <see cref="T:PipelineContext"/> class.
        /// </summary>
        /// <param name="container">The container.</param>
        [CLSCompliant(false)]
        public PipelineContext(IDictionary container) : base(container) { }
        #endregion

        #region Nested Types
        /// <summary>
        /// Keys used to access the properties in the dictionary.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1815:OverrideEqualsAndOperatorEqualsOnValueTypes"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible")]
        public struct KeyNames
        {
            /// <remarks />
            public const string CacheManager = "CacheManager";
            /// <remarks />
            public const string CatalogCacheConfiguration = "CatalogCacheConfiguration";
            /// <remarks />
            public const string CatalogContext = "CatalogContext";
            /// <remarks />
            public const string CatalogLanguage = "catalog_language";
            /// <remarks />
            public const string CommerceResources = "CommerceResources";
            /// <remarks />
            public const string Evaluator = "Evaluator";
            /// <remarks />
            public const string MessageManager = "MessageManager";
            /// <remarks />
            public const string TransactionConfigConnectionString = "TransactionConfigConnectionString";
        }
        #endregion
    }
}
